home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / dman310.zip / DMGRAPH.DOC < prev    next >
Text File  |  1993-04-25  |  10KB  |  234 lines
  1.  
  2.  
  3.                    DoorMan Stats Grapher v3.00
  4.                           Documentation
  5.  
  6.  
  7. OVERVIEW
  8.  
  9. DoorStat is a companion program to DoorMan.  It is a utility to
  10. read the DOORMAN.DAT file created by DoorMan and create Bar
  11. Graphs based on the door usage data contained in it.  Graphs can
  12. be created and viewed in three different ways.  First, users can
  13. choose Graphs from within the door.  This will allow them to
  14. define and view as many graphs they want.  Second, from the
  15. Config Editor, which is built into the program, you can create
  16. and view graphs.  Lastly, the program can be run during nightly
  17. maintenance to create/update up to 10 pre-defined graphs by
  18. calling it with the config file.  The program will create graphs
  19. in ANSI, ASCII, and WildCat! 3.0 formats.
  20.  
  21.  
  22. REQUIREMENTS
  23.  
  24. All the program requires is that it be placed in the same
  25. directory as DoorMan so it may access the DoorMan data files. 
  26.  
  27. You must also have some data present for the program to 
  28. graph!  Keep in mind, if you don't stay in a door for at least
  29. one minute, DoorMan won't write that usage to the .DAT file!
  30. Before you can create a graph, you MUST go into a door and stay
  31. at least one minute!
  32.  
  33. SETUP
  34.  
  35. The first time you run DoorStat, you will be prompted for three
  36. defaults.  The program will only ask for these once, but you may
  37. always change them from the Config File Editor.  These defaults
  38. are as follows:
  39.  
  40. Directory:  This is the full path to your bulletins
  41.             directory. If the program is run with the
  42.             config file, this is where it is going to put
  43.             the graphs it creates.
  44.  
  45. Default ANSI Extension:  The default extension to put on
  46.                          ANSI bulletins.
  47.  
  48. Default ASCII Extension:  The default extension to put on
  49.                           ASCII bulletins.
  50.  
  51.      Note:  If you are running a WildCat! 3.0 system and choose
  52.             to create WildCat! 3.0 bulletins, then the last two
  53.             defaults don't mean anything.  Anytime the program is
  54.             instructed to create a WildCat! 3.0 bulletin, it uses
  55.             .BBS as the extension.
  56.  
  57.  
  58. Once you have defined these defaults, you will be given the
  59. Config File Edit Menu.
  60.  
  61. CONFIG FILE EDIT MENU OPTIONS
  62.  
  63. The Config File Editor serves two purposes.  First and foremost,
  64. it is where you define the "pre-defined" bulletins to be created
  65. during maintenance each night.  However, by using the preview
  66. option, it can also be used to experiment and to look at
  67. statistics you may not want to use in your bulletins.  No matter
  68. which purpose you want to use it for, the same menu options
  69. apply.  Following are there descriptions.
  70.  
  71. VIEW CURRENT CONFIG
  72.  
  73. This option is pretty self-explanatory.  When you choose it, you
  74. are given the defaults you have defined in a box, and the list of
  75. bulletins you have defined in the config file.
  76.  
  77. CHANGE DEFAULTS
  78.  
  79. Again, this one is pretty self-explanatory
  80.  
  81. ADD BULLETIN
  82.  
  83. This is the option you will undoubtedly use the most.  This is
  84. where you define the bulletins you want to preview and select the
  85. ones you want to add to the config file.  When you select this
  86. option, the first thing you have to do is select a subject for
  87. the bulletin.  Below are your choices and an explanation of each:
  88.  
  89.      Category:  This will allow you to graph the activity of one
  90.                 category over time, or, to create a graph
  91.                 comparing the activity of ALL categories.  When
  92.                 you choose this option, you will be asked whether
  93.                 you want One category or All.  If you choose one,
  94.                 then you will asked to choose which category
  95.                 from a list.
  96.  
  97.      Door:  This will allow you to graph the activity of one door
  98.             over time, or, to compare the activity of ALL doors
  99.             in one category.  When you choose this option, the
  100.             first thing you will be asked to do is to choose the
  101.             category the door(s) you want is/are in.  Once you
  102.             have chosen a category from the list, you will be 
  103.             prompted whether to use One door or All.  If you
  104.             choose one, you will be shown the list of doors in
  105.             that category and asked to choose one.
  106.  
  107.      Summary:  This option allows you to graph the activity of
  108.                ALL doors over time.
  109.  
  110. Once you have chosen a subject for the graph, you must then
  111. decide on what basis you want to compare/list the data.  Your
  112. choices are as follows:
  113.  
  114.      Times Used:  This will graph the activity of the subject
  115.                   based on the number of times it was used.
  116.  
  117.      Time in Door:  This will graph the activity of the subject
  118.                     based on the minutes of BBS time used.
  119.  
  120.  
  121. OK, now that we have a subject and know what data to use, the
  122. next step is to decide how much data to use.  In other words,
  123. define the scope of the bulletin.  Your choices:
  124.  
  125.      Day:  Graphs the activity of the subject over one day broken
  126.            down hour.  This is handy for finding out when the
  127.            best/worst time to call the BBS is if you want to play
  128.            a game.  Once you have chosen this option, you will be
  129.            asked which day to display.  You may choose any single
  130.            day during the month, -1 for yesterday's activity, 0 
  131.            for today's activity, or A for ALL days activity.   No
  132.            
  133.      Month:  Graphs the activity of the subject for a given month
  134.              broken down by day.  Once you choose this option,
  135.              you will be prompted for the month.  Simply enter
  136.              the 3 letter abbreviation, or Cur for this month.
  137.              On my system, this graph revealed a weekly cycle in
  138.              door usage.  It may help your users better decide 
  139.              what day to call during the week.
  140.  
  141.      Total:  Graphs the activity of the subject over the total
  142.              history available broken down by day.  This is
  143.              limited to 60 days due to the size of the screen. 
  144.              If there are more than 60 days of data present, the
  145.              program will get the data for the most recent 60
  146.              days.  In other words, the graph will always
  147.              start with yesterday and go backwards up to 60 days.
  148.  
  149. Next, you will be prompted for a node number.  This will allow
  150. you to look at door usage on individual nodes, or All nodes.
  151.  
  152. Lastly, you will be prompted for the Security Level to use when
  153. creating the graph.  When a user creates a graph within the door,
  154. their security level is used.  However, when you create a graph
  155. to be used for a bulletin, DoorStat has no way of knowing what
  156. users will be viewing it.  Therefore, you tell it what to do
  157. here.  The result will be the same as a user with this security
  158. level creating a graph within the door.  Then, you can decide
  159. which users to show the bulletin to.
  160.  
  161. OK, now we have all the data needed to create the graph.  At this
  162. point, the program will as you if you want to preview the graph. 
  163. Say yes, and the program will go gather the data, create the
  164. graph, and then show it to you.  Once you're finished looking at
  165. it, the program will ask you whether or not to add the bulletin
  166. to the config file.
  167.  
  168. If you say Yes, then you will be prompted for the following Info:
  169.  
  170.      FileName:  This is the filename the program will use when
  171.                 creating the bulletin.  There is no need to put a
  172.                 path or an  extension since these are defined in
  173.                 the defaults.  The filename can be any valid DOS
  174.                 filename.
  175.  
  176.      Type: This can be ANSI, ASCII, Both, or WildCat! 3.0.  Which
  177.            type you choose decides what type file(s) are created
  178.            when the program runs during maintenance.
  179.  
  180.  
  181. REMOVE BULLETIN
  182.  
  183. Self explanatory.  However, there is a "Hidden" feature.  While
  184. experimenting/testing/playing with the program, I found that I
  185. kept adding a bunch of bulletins to the config file.  I would end
  186. up adding 10 bulletins, hitting the max, and not being able to
  187. play anymore.  So, I added a command to remove ALL the bulletins
  188. in the file.  When you are prompted which bulletin to remove,
  189. simply enter A (not a) and Poof! all of them are gone!
  190.  
  191. QUIT
  192.  
  193. Hmmm?  Wonder what that does?
  194.  
  195. Well, that about covers what the program does when run without a
  196. config file.  Now, for what it does with one.  After you've
  197. created one, you can call the program with it on the command line
  198. like so:
  199.  
  200.      DMGRAPH DMGRAPH.CFG
  201.  
  202. This will cause the program to automatically create the bulletins
  203. you have defined.  This is what you would do if you want to use
  204. the program in nightly maintenance.  What use is that if users
  205. can create their own bulletins, you ask?  Well, even though users
  206. have that option, I have found that there are still some people
  207. out there who will go to the bulletins menu and look at the
  208. graphs but won't go into Graphs from the door.  This option is
  209. for those people.  Also, it comes in handy for people who don't
  210. play games at all but are interested in how the BBS is being
  211. used.  
  212.  
  213. REGISTRATION INFORMATION
  214.  
  215. DMGraph is provided as an optional program with the DoorMan
  216. package.  No since making you pay a higher price for the package
  217. if you don't want to make graphs.  For this reason, it has its
  218. own key and registration fee.  Also, by doing it this way, you
  219. can come back at some future date and register the utility.  The
  220. price of the utility alone is $20.  However, if you register both
  221. programs at once, you get the utility for $10.  This only applies
  222. if both programs are registered at the SAME time!  If you
  223. register DoorMan, then come back a day later and want to register
  224. DMGraph, it will cost $20!  Once you register, you will get a
  225. non-expiring key which will be good for this and all future
  226. versions of the program.
  227.  
  228. SUGGESTIONS?
  229.  
  230. As with all my programs, I feel that the end user should have the
  231. final say in how a program operates.  Therefore, if you don't
  232. like something in the program or would like to see something
  233. added, feel free to send me a suggestion!  I will attempt to
  234. implement any suggestion I get!